docs: Document database exceptions#571
Conversation
loopassembly
changed the title
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation covering Serverpod database exception types and how to handle them, and links the CRUD guide to this new reference.
Changes:
- Added a new “Database exceptions” concept page with exception taxonomy and examples.
- Linked the CRUD
updateByIdsection to the new exceptions documentation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/06-concepts/06-database/15-exceptions.md | Introduces a new page documenting database exception behavior and types. |
| docs/06-concepts/06-database/05-crud.md | Adds a cross-link from CRUD docs to the new exceptions page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thanks for the review notes. I pushed a small follow-up commit ( I also checked the table and link comments. The table is using normal single-pipe Markdown syntax, and |
Swiftaxe
left a comment
Swiftaxe
left a comment
There was a problem hiding this comment.
A solid concept page! Nice!
Commented on a couple of minor things.
Thank you!
| @@ -0,0 +1,92 @@ | |||
| # Database exceptions | |||
There was a problem hiding this comment.
A convention we just started following is to add a frontmatter description to new pages for SEO.
| # Database exceptions | |
| --- | |
| description: Serverpod wraps database failures in typed exceptions. Learn when each exception is thrown and how to handle query errors, row-level failures, and SQLite integrity checks. | |
| --- | |
| # Database exceptions |
| @@ -0,0 +1,92 @@ | |||
| # Database exceptions | |||
|
|
|||
| Serverpod wraps database failures in exceptions that implement `DatabaseException`. | |||
There was a problem hiding this comment.
Every line hard-wraps at 72 characters. Remove to match the rest of the docs.
Summary
updateByIddocs to the new exceptions page.Verification
npx --yes --cache ./.npm-cache markdownlint-cli docs/06-concepts/06-database/15-exceptions.md docs/06-concepts/06-database/05-crud.mdgit diff --checkI did not run a docs build because
serverpod_docs/AGENTS.mdsays not to run build commands locally.Closes serverpod/serverpod#3281